
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>stratified_plume_model.ModelParams &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="stratified_plume_model.InnerPlume" href="stratified_plume_model.InnerPlume.html" />
    <link rel="prev" title="stratified_plume_model.Model.simulate" href="stratified_plume_model.Model.simulate.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="stratified-plume-model-modelparams">
<h1>stratified_plume_model.ModelParams<a class="headerlink" href="#stratified-plume-model-modelparams" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="stratified_plume_model.ModelParams">
<em class="property">class </em><code class="sig-prename descclassname">stratified_plume_model.</code><code class="sig-name descname">ModelParams</code><span class="sig-paren">(</span><em class="sig-param">profile</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/stratified_plume_model.html#ModelParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#stratified_plume_model.ModelParams" title="Permalink to this definition">¶</a></dt>
<dd><p>Fixed model parameters for the stratified plume model</p>
<p>This class stores the set of model parameters that should not be adjusted
by the user and that are needed by the stratified plume model.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>profile</strong><span class="classifier"><cite>ambient.Profile</cite> object</span></dt><dd><p>The ambient CTD object used by the simulation.</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This object inherits the <cite>single_bubble_model.ModelParams</cite> object, which
defines the attribute <cite>rho_r</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Attributes</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>rho_r</strong><span class="classifier">float</span></dt><dd><p>Reference density (kg/m^3) evaluated at mid-depth of the water body.</p>
</dd>
<dt><strong>alpha_1</strong><span class="classifier">float</span></dt><dd><p>entrainment coefficient from the ambient fluid to the inner plume</p>
</dd>
<dt><strong>alpha_2</strong><span class="classifier">float</span></dt><dd><p>entrainment coefficient from the inner plume to the outer plume</p>
</dd>
<dt><strong>alpha_3</strong><span class="classifier">float</span></dt><dd><p>entrainment coefficient from the ambient fluid to the outer plume</p>
</dd>
<dt><strong>lambda_2</strong><span class="classifier">float</span></dt><dd><p>spreading rate of dissolved constituents</p>
</dd>
<dt><strong>epsilon</strong><span class="classifier">float</span></dt><dd><p>continuous peeling parameter (see Crounse 2000)</p>
</dd>
<dt><strong>c1</strong><span class="classifier">float</span></dt><dd><p>coefficient for counterflow entrainment model</p>
</dd>
<dt><strong>c2</strong><span class="classifier">float</span></dt><dd><p>coefficient for counterflow entrainment model</p>
</dd>
<dt><strong>fe</strong><span class="classifier">float</span></dt><dd><p>extra entrainment factor when the inner plume hits the free
surface</p>
</dd>
<dt><strong>gamma_i</strong><span class="classifier">float</span></dt><dd><p>momentum amplification factor for inner plume (see Milgram 1983)</p>
</dd>
<dt><strong>gamma_o</strong><span class="classifier">float</span></dt><dd><p>momentum amplification factor for outer plume</p>
</dd>
<dt><strong>Fr_0</strong><span class="classifier">float</span></dt><dd><p>initial plume Froude number (see Wueest et al. 1992)</p>
</dd>
<dt><strong>Fro_0</strong><span class="classifier">float</span></dt><dd><p>initial plume Froude number for outer plume segments</p>
</dd>
<dt><strong>nwidths</strong><span class="classifier">float</span></dt><dd><p>average size of detraining eddies as a fraction of the plume
half-width</p>
</dd>
<dt><strong>naverage</strong><span class="classifier">float</span></dt><dd><p>number of previous outer plume solutions to average</p>
</dd>
<dt><strong>g</strong><span class="classifier">float</span></dt><dd><p>acceleration of gravity (m/s^2)</p>
</dd>
<dt><strong>Ru</strong><span class="classifier">float</span></dt><dd><p>universal ideal gas constant (J/(mol K))</p>
</dd>
</dl>
</dd>
</dl>
<dl class="method">
<dt id="stratified_plume_model.ModelParams.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">profile</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/stratified_plume_model.html#ModelParams.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#stratified_plume_model.ModelParams.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self.  See help(type(self)) for accurate signature.</p>
</dd></dl>

<p class="rubric">Methods</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#stratified_plume_model.ModelParams.__init__" title="stratified_plume_model.ModelParams.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(self, profile)</p></td>
<td><p>Initialize self.</p></td>
</tr>
</tbody>
</table>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/spm.html">Overview of Stratified Plume Model Module</a><ul>
      <li>Previous: <a href="stratified_plume_model.Model.simulate.html" title="previous chapter">stratified_plume_model.Model.simulate</a></li>
      <li>Next: <a href="stratified_plume_model.InnerPlume.html" title="next chapter">stratified_plume_model.InnerPlume</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/spm/stratified_plume_model.ModelParams.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>